@ GNU AS assembler header file for ImageFileRender
@ Written by DefMod (Dec  9 2012) on Sun Dec  9 15:50:43 2012
@ Tom Hughes, tom@compton.nu, 22 Nov 2002

@ OSLib---efficient, type-safe, transparent, extensible,
@ register-safe API coverage of RISC OS
@ 
@ Copyright (c) 1994-2012 Jonathan Coxhead and OSLib maintainers
@ 
@ Licence:
@ 
@    OSLib is free software; you can redistribute it and/or modify
@ it under the terms of the GNU General Public License as published by
@ the Free Software Foundation; either version 1, or (at your option)
@ any later version - and this with the following clarification and
@ special exception:
@ 
@    Linking this library statically or dynamically with other modules
@ is making a combined work based on this library. Thus, the terms
@ and conditions of the GNU General Public License cover the whole
@ combination.
@ 
@    As a special exception, the copyright holders of this library
@ give you permission to link this library with independent modules
@ to produce an executable, regardless of the license terms of these
@ independent modules, and to copy and distribute the resulting
@ executable under terms of your choice, provided that you also meet,
@ for each linked independent module, the terms and conditions of the
@ license of that module. An independent module is a module which is
@ not derived from or based on this library. If you modify this
@ library, you may extend this exception to your version of the library,
@ but you are not obliged to do so. If you do not wish to do so, delete
@ this exception statement from your version.
@ 
@    OSLib is distributed in the hope that it will be useful,
@ but WITHOUT ANY WARRANTY; without even the implied warranty of
@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@ GNU General Public License for more details.
@ 
@    You should have received a copy of the GNU General Public License
@ along with this programme; if not, write to the Free Software
@ Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, USA.

#ifndef ImageFileRender_Hdr
#  define ImageFileRender_Hdr

#  ifndef Get_Types
#    define Get_Types
#    include "oslib/Types.Hdr"
#  endif

#  ifndef Get_OS
#    define Get_OS
#    include "oslib/OS.Hdr"
#  endif

#  ifndef Get_OSSpriteOp
#    define Get_OSSpriteOp
#    include "oslib/OSSpriteOp.Hdr"
#  endif

#  ifndef Get_PDriver
#    define Get_PDriver
#    include "oslib/PDriver.Hdr"
#  endif

@Symbols for constants
#  define ImageFileRender_DefaultImage 0x0
#  define ImageFileRender_BaseDetailQuery 0x0
#  define ImageFileRender_ImageIsSolid 0x1
#  define ImageFileRender_TransformationType 0x7
#  define ImageFileRender_TransformationTypeShift 0x0
#  define ImageFileRender_RenderToFit 0x0
#  define ImageFileRender_RenderScaled 0x1
#  define ImageFileRender_RenderTransformed 0x2
#  define ImageFileRender_ColourMappingSupplied 0x8
#  define ImageFileRender_IgnoreDocumentOrigin 0x10
#  define ImageFileRender_ReturnOSUnits 0x20
#  define ImageFileRender_Quality 0x1c0
#  define ImageFileRender_QualityShift 0x6
#  define ImageFileRender_DefaultQuality 0x0
#  define ImageFileRender_LowestQuality 0x1
#  define ImageFileRender_HighestQuality 0xf
#  define ImageFileRender_TransformationCapabilities 0x3
#  define ImageFileRender_TransformationCapabilitiesShift 0x0
#  define ImageFileRender_NoTransformation 0x0
#  define ImageFileRender_FixedAspectRatio 0x1
#  define ImageFileRender_AnyAspectRatio 0x2
#  define ImageFileRender_AnyTransformation 0x3
#  define ImageFileRender_SupportsColourMapping 0x4
#  define ImageFileRender_SupportsIrregularShapes 0x8
#  define ImageFileRender_MaximumQualityLevel 0xf0
#  define ImageFileRender_MaximumQualityLevelShift 0x4
#  define ImageFileRender_DefaultQualityLevel 0xf00
#  define ImageFileRender_DefaultQualityLevelShift 0x8

@Symbols for structure offsets and sizes
        .struct 0
        .skip   Int
ImageFileRender_SequenceNumber : 

        .struct 0
ImageFileRender_FitBlock_width : .skip   Int
ImageFileRender_FitBlock_height: .skip   Int
ImageFileRender_FitBlock_border: .skip   Int
ImageFileRender_FitBlock_angle : .skip   Int
ImageFileRender_FitBlock       : 

        .struct 0
ImageFileRender_TransformationData_to_fit: .skip   ImageFileRender_FitBlock
        .struct 0
ImageFileRender_TransformationData_scaled: .skip   OS_Factors
        .struct 0
ImageFileRender_TransformationData_transformed: .skip   OS_Trfm
ImageFileRender_TransformationData: 

        .struct 0
        .skip   Int
ImageFileRender_QueryType      : 

        .struct 0
        .skip   Bits
ImageFileRender_ImageFlags     : 

        .struct 0
ImageFileRender_BaseDetails_sequence: .skip   ImageFileRender_SequenceNumber
ImageFileRender_BaseDetails_xdpi: .skip   Int
ImageFileRender_BaseDetails_ydpi: .skip   Int
ImageFileRender_BaseDetails_colour_type: .skip   OSSpriteOp_ModeWord
ImageFileRender_BaseDetails_image_flags: .skip   ImageFileRender_ImageFlags
ImageFileRender_BaseDetails    : 

        .struct 0
        .skip   Bits
ImageFileRender_Flags          : 

        .struct 0
        .skip   Bits
ImageFileRender_RendererFlags  : 

@ abstract type
#  define ImageFileRender_Magic 4

        .struct 0
ImageFileRender_Renderer_api_version: .skip   Int
ImageFileRender_Renderer_flags : .skip   ImageFileRender_RendererFlags
ImageFileRender_Renderer_file_type: .skip   Bits
ImageFileRender_Renderer_magic : .skip   ImageFileRender_Magic
ImageFileRender_Renderer_name  : .skip   Ptr
ImageFileRender_Renderer_workspace: .skip   Ptr
ImageFileRender_Renderer_start : .skip   Ptr
ImageFileRender_Renderer_stop  : .skip   Ptr
ImageFileRender_Renderer_render: .skip   Ptr
ImageFileRender_Renderer_bbox  : .skip   Ptr
ImageFileRender_Renderer_declare_fonts: .skip   Ptr
ImageFileRender_Renderer_info  : .skip   Ptr
ImageFileRender_Renderer       : 

        .struct 0
ImageFileRender_ImageDescriptor_data: .skip   Ptr
ImageFileRender_ImageDescriptor_size: .skip   Int
ImageFileRender_ImageDescriptor_extension_data: .skip   Ptr
ImageFileRender_ImageDescriptor_sequence: .skip   ImageFileRender_SequenceNumber
ImageFileRender_ImageDescriptor_private_data: .skip   Ptr
ImageFileRender_ImageDescriptor: 

        .struct 0
ImageFileRender_RenderingDescriptor_flags: .skip   ImageFileRender_Flags
ImageFileRender_RenderingDescriptor_trfm: .skip   OS_Trfm
ImageFileRender_RenderingDescriptor_bbox: .skip   OS_Box
ImageFileRender_RenderingDescriptor_mapping: .skip   OSSpriteOp_ColourMapping
ImageFileRender_RenderingDescriptor: 

        .struct 0
ImageFileRender_BBoxDescriptor_flags: .skip   ImageFileRender_Flags
ImageFileRender_BBoxDescriptor_trfm: .skip   OS_Trfm
ImageFileRender_BBoxDescriptor_bbox: .skip   OS_Box
ImageFileRender_BBoxDescriptor : 

        .struct 0
ImageFileRender_DeclareFontsDescriptor_flags: .skip   ImageFileRender_Flags
ImageFileRender_DeclareFontsDescriptor_pdriver_flags: .skip   PDriver_FontFlags
ImageFileRender_DeclareFontsDescriptor: 

        .struct 0
ImageFileRender_InfoDescriptor_query: .skip   ImageFileRender_QueryType
ImageFileRender_InfoDescriptor_size: .skip   Int
ImageFileRender_InfoDescriptor_data: .skip   Ptr
ImageFileRender_InfoDescriptor : 


@Symbols for SWI's and SWI reason codes
.set XImageFileRender_Render,0x762c0
.set ImageFileRender_Render,0x562c0
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 = file_type (Bits)
   @  R2 -> data (data)
   @  R3 = size (Int)
   @  R4 -> extension_data (data)
   @  R5 = sequence (ImageFileRender_SequenceNumber)
   @  R6 = xorigin (Int)
   @  R7 = yorigin (Int)
   @  R8 -> transformation_data (ImageFileRender_TransformationData)
   @  R9 -> colour_mapping (OSSpriteOp_ColourMapping)

.set XImageFileRender_BBox,0x762c1
.set ImageFileRender_BBox,0x562c1
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 = file_type (Bits)
   @  R2 -> data (data)
   @  R3 = size (Int)
   @  R4 -> extension_data (data)
   @  R5 = sequence (ImageFileRender_SequenceNumber)
   @  R6 -> transformation_data (ImageFileRender_TransformationData)
   @  R7 = bbox (pointer to OS_Box)

.set XImageFileRender_Transform,0x762c2
.set ImageFileRender_Transform,0x562c2
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 = file_type (Bits)
   @  R2 -> data (data)
   @  R3 = size (Int)
   @  R4 -> extension_data (data)
   @  R5 = sequence (ImageFileRender_SequenceNumber)
   @  R6 -> transformation_data (ImageFileRender_TransformationData)
   @  R7 = trfm (pointer to OS_Trfm)
   @Exit
   @  R0 = xdpi (Int)
   @  R1 = ydpi (Int)

.set XImageFileRender_DeclareFonts,0x762c3
.set ImageFileRender_DeclareFonts,0x562c3
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 = file_type (Bits)
   @  R2 -> data (data)
   @  R3 = size (Int)
   @  R4 -> extension_data (data)
   @  R5 = sequence (ImageFileRender_SequenceNumber)
   @  R6 = pdriver_flags (PDriver_FontFlags)

.set XImageFileRender_Info,0x762c4
.set ImageFileRender_Info,0x562c4
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 = file_type (Bits)
   @  R2 -> data (data)
   @  R3 = size (Int)
   @  R4 -> extension_data (data)
   @  R5 = sequence (ImageFileRender_SequenceNumber)
   @  R6 = query (ImageFileRender_QueryType)
   @  R7 = query_data (pointer to data)
   @  R8 = query_data_size (Int)
   @Exit
   @  R8 = size_used (Int)

#  define ImageFileRender_InfoBaseDetails 0x0
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 = file_type (Bits)
   @  R2 -> data (data)
   @  R3 = size (Int)
   @  R4 -> extension_data (data)
   @  R5 = sequence (ImageFileRender_SequenceNumber)
   @  R6 = &0
   @  R7 = base_details (pointer to ImageFileRender_BaseDetails)
   @  R8 = base_details_size (Int)
   @Exit
   @  R8 = size_used (Int)

.set XImageFileRender_RendererInfo,0x762c5
.set ImageFileRender_RendererInfo,0x562c5
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 = file_type (Bits)
   @  R2 = magic (ImageFileRender_Magic)
   @Exit
   @  R0 -> definition (ImageFileRender_Renderer)
   @  R1 = name (pointer to Char)

.set XImageFileRender_Register,0x762c6
.set ImageFileRender_Register,0x562c6
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 -> definition (ImageFileRender_Renderer)
   @Exit
   @  R1 = api_version (Int)

.set XImageFileRender_Deregister,0x762c7
.set ImageFileRender_Deregister,0x562c7
   @Entry
   @  R0 = flags (ImageFileRender_Flags)
   @  R1 = file_type (Bits)
   @  R2 -> name (Char)
   @  R3 = magic (ImageFileRender_Magic)
   @Exit
   @  R1 = api_version (Int)

#  define Service_ImageFileRenderStarted 0x80d40
   @Entry
   @  R0 = api_version (Int)
   @  R1 = &80D40

#  define Service_ImageFileRenderDying 0x80d41
   @Entry
   @  R0 = api_version (Int)
   @  R1 = &80D41

#  define Service_ImageFileRenderRendererChanged 0x80d42
   @Entry
   @  R0 = api_version (Int)
   @  R1 = &80D42
   @  R2 = file_type (Bits)

#endif
